﻿// Bravura : A music composition and audio synthesis framework.
//
// Copyright © 2011 Paul Vanukoff (pvanukoff@gmail.com)
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see http://www.gnu.org/licenses/.

using System.Collections.Generic;
using Bravura.Core.Common;

namespace Bravura.Core.PluginLib
{
	/// <summary>
	/// Common audio plugin interface. All audio plugins must implement this interface. 
	/// </summary>
	public interface IAudioPlugin : ICommandTarget
	{
		/// <summary>
		/// Configure the plugin.
		/// </summary>
		void Configure(List<IConfigItem> configuration);

		/// <summary>
		/// Sets a value of a plugin (run-time) setting.
		/// </summary>
		void SetPluginSetting(string key, string value);

		/// <summary>
		/// Sets a value of a plugin (run-time) control.
		/// </summary>
		void SetPluginControl(string key, double value);

		/// <summary>
		/// Allows the plugin host to assign an audio output buffer to the plugin.
		/// </summary>
		void AssignOutputBuffer(int channelNum, IAudioBuffer buffer);

		/// <summary>
		/// Allows the plugin host to assign an audio input buffer to the plugin.
		/// </summary>
		void AssignInputBuffer(int channelNum, IAudioBuffer buffer);

		/// <summary>
		/// Acquire or open plugin resources before use.
		/// </summary>
		void Open();

		/// <summary>
		/// Process "count" number of samples.
		/// </summary>
		void Process(int count);

		/// <summary>
		/// Release or close plugin resources.
		/// </summary>
		void Close();
	}
}
